home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / VIG-PV12.ZIP / PROVOTE.DOC < prev    next >
Encoding:
Text File  |  1994-07-07  |  16.3 KB  |  330 lines
  1. ProVote v1.1 by ViGilante on 5/26/94
  2. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3. I am confident you will find this to be the most feature packed, versatile, 
  4. configureable, reliable, bug-free, backdoor-free, and maintenance-free NUV
  5. type PPE for PCBoard out there.
  6.  
  7. IF UPGRADING FROM VERSION 1.1:
  8.   You can just drop in the PROVOTE.PPE file.  Read the HISTORY.DOC file if
  9.   you want to take advantage of the new features.
  10.   
  11.  
  12. IF UPGRADING FROM VERSION 1.0:
  13.   I just can't control myself from changing the format of some
  14.   of the configuration files, so your BEST BET is to just completely
  15.   re-install the whole package.  Here are files you will DEFINATELY need to
  16.   replace: PROVOTE.CNF, STRINGS.DAT, EXIT.PCB, and FEEDBACK.PCB.  There may
  17.   be more, so be warned.  You must also create a directory off the PROVOTE
  18.   directory called GONE, the infoforms of DELETED users will be placed there.
  19.   EVEN IF YOU RUN v1.1ß THERE ARE NEW CHANGES!
  20.  
  21. ***READ THE HISTORY.DOC FILE***
  22.  
  23. Introduction
  24. ~~~~~~~~~~~~
  25. This PPE is a companion to ProMatrix, a logon shell for PCBoard.  It was
  26. designed to work in conjunction with ProMatrix, but should work just as well
  27. with any other logon shell, or without any shell at all.
  28.  
  29. There are so many features and configurable aspects of this PPE that I really
  30. don't know where to begin.  Thorough perusal of this document, STRINGS.DAT,
  31. PROVOTE.CNF, and HISTORY.DOC is highly recommended.
  32.  
  33.  
  34. Quick Setup
  35. ~~~~~~~~~~~
  36. Create a separate directory, perhaps c:\pcb\ppe\provote, and unzip everything
  37. into this directory.  Do NOT unzip it to the same dir as ProMatrix, if you
  38. are running it, as some files WILL conflict.  Go to the dir you just unzipped
  39. everything to and unzip one of the included ANSI sets in that dir.
  40.  
  41. Simply install this in PCB anywhere so that all your users will run this PPE
  42. after logging on.  Here is the recommended method: go into pcbsetup for each
  43. node, hit (G), (D), and set "Scan for New Bulletins" to YES.  Next load up
  44. MKPCBTXT and go to record #665 and replace the "Scanning for new bulletins..."
  45. prompt with a display file, perhaps "%c:\pcb\disp\prompt.665".  Now create
  46. the file you just named and make it look something like this:
  47.  
  48. -----Start---------------------
  49. !c:\pcb\ppe\slogon\slogon.ppe
  50. !c:\pcb\ppe\provote\provote.ppe
  51.  
  52. Scanning for new bulletins...
  53. -----Stop----------------------
  54.  
  55. Only add the first line if you are running Slogon, obviously.
  56.  
  57. There are many other places to install this, but I find this one to be the 
  58. best as you can add as many more ppe's to your logon process as you want,
  59. all in one nice and neat place.  Note that if you install PPE's in your logon
  60. script, and you logon locally as the sysop, none of them run.  If you have
  61. tried your own method of installation and it didn't work, try it this way.
  62.  
  63. PAY SPECIAL ATTENTION TO LINE #11 IN PROVOTE.CNF!  This line determines the
  64. maximum people allowed in NUV at one time AND it must be GREATER THAN the
  65. amount of entries in your PWRD file (how many different sec levels you have).
  66. MAKE SURE YOU SET THIS NUMBER HIGH ENOUGH SO THAT YOU WILL NEVER HAVE THAT
  67. MANY NEW USERS AT ONE TIME!  I should have just kept this hardcoded <shrug>.
  68.  
  69.  
  70. Advanced Setup
  71. ~~~~~~~~~~~~~~
  72. ProVote can be installed three different ways by the use of command line
  73. switches.
  74.  
  75. No Switch:  Detailed above, the main thing to note is that if a voter
  76.   has voted on everyone, provote will not execute (except sysops).
  77.  
  78. /VIEW:  This is ideal for a CMD.LST installation, so users can scan through
  79.   all the applicants and view their stats, other users comments, etc.  I
  80.   have it set up as the "NUV" command.
  81.  
  82. /NEWONLY:  When this is used, it will check to see if the user is either
  83.   applying for access or checking his voting progress and let them do so as
  84.   usual.  All other users will exit immediately without anything being
  85.   displayed at all.  All this is completely unnecessary, but some sysops might
  86.   want new users to do their thing and get hung up on IMMEDIATELY after logon,
  87.   and yet have validated users vote on new users LATER ON in the logon process
  88.   or perhaps even as a command from the Main prompt.  In the example file
  89.   above (prompt.665) you would add an ADDITIONAL call to provote BEFORE the
  90.   call to SLOGON, using this switch.
  91.  
  92.  
  93. What will happen
  94. ~~~~~~~~~~~~~~~~
  95. The first time anyone runs this, three subdirs will be created out of the main
  96. one: DATA\, SAVE\, and GONE\.  The DATA dir is where all the completed
  97. infoforms and voting stats are kept, the SAVE dir is where completed infoforms
  98. are moved to if a user is successfully validated through ProVote, and the GONE
  99. dir is where completed infoforms are moved to if a user is deleted through
  100. ProVote.  See INFOHUNT.DOC for more infoformation on the SAVE/GONE dirs.  Also,
  101. a 0 byte file called WAITING.LST will be created in the DATA dir.
  102.  
  103. When a new user enters this PPE for the first time, it will ask them to fill
  104. out a bunch of infoforms, have them leave a new user application letter to the
  105. sysop, and optionally hang up on them.
  106.  
  107. When a new user enters after the first time, it will show them their current
  108. voting stats and optionally hang up on them.
  109.  
  110. When a validated user enters, he will vote on all pending applicants.  If a
  111. deciding vote is cast, the user being voted on will be validated or deleted
  112. on the spot.
  113.  
  114. When a sysop enters, in addition to the standard voting choices (Y/N/A) there
  115. will be other options available:  Validate (Validate user immediately),
  116. Delete (Delete user immediately), Remove (Remove user from nuving, leaving
  117. their user record untouched), Stuff (stuff the ballot box with yes or no
  118. votes), and Abort (where NOTHING happens, which is very different from
  119. Abstaining..).
  120.  
  121. The Review (Review infoforms) option is always available, and always the
  122. default choice.  This is done to force voters to THINK about what they
  123. are doing instead of just slamming RETURN through all your users.
  124.  
  125. Every major action will be logged to the CALLERx file, the PPE will always
  126. clean up after itself, and the Sysop Comment #2 field of users being voted
  127. on will reflect either their current voting stats, "USER HUNG UP" if they
  128. dropped carrier before everything was completed, or "USER WAS _________" if
  129. they were validated/deleted through ProVote in ANY way- by enough yes/no
  130. votes, having their name listed in CARPET.RED, or the VALIDATE/DELETE user
  131. choice on the voting menu.  In this way you can easily see what is going on
  132. while browsing through the user editor in PCBSM.
  133.  
  134.  
  135. What will happen IF?
  136. ~~~~~~~~~~~~~~~~~~~~
  137. IF you try to edit WAITING.LST:  There is NEVER a need to edit this file, and
  138.   you will most likely screw things up (temporarily, it will correct itself) if
  139.   you do.
  140.  
  141. IF you try to edit xxxxx.DAT:  These are the individual data files used to
  142.   keep track of each new users' voting stats.  Again, there is never a need to
  143.   edit this, so don't.
  144.  
  145. IF you validate/delete a user through a process other than the PROVOTE.PPE,
  146.   like with PCBSM, you don't have to worry about also removing them in ProVote.
  147.   Your users will continue to vote on this person, but it will be meaningless-
  148.   when it comes time to validate/delete them, nothing will happen unless their
  149.   current sec level is that of a new user.
  150.  
  151. IF a newuser hangs up before all infoforms are completed, they will simply be
  152.   forced right back into filling them out again the next time they call.
  153.  
  154.  
  155. Detailed Configuration
  156. ~~~~~~~~~~~~~~~~~~~~~~
  157. CONFREG.CNF: Here you can auto-register your users into your conferences.
  158.   The format of the file is simply 2 values on each line, the first is the
  159.   conference, the second is the conference flags to assign for that conf.
  160.   The conference flags are:
  161.  
  162.     1 = Set the conference registration flag
  163.     2 = Set the conference expired access flag
  164.     4 = Set the conference selected flag
  165.     8 = Set the conference SysOp access flag
  166.     
  167.   Just add up the values for all the flags you want to give for that
  168.   conference.  For example, if you want to register a user in conf 4 with the
  169.   CONFERENCE REGISTRATION, CONFERENCE EXPIRED ACCESS, and CONFERENCE SELECTED
  170.   flags, you would add a line to CONFREG.CNF like:
  171.   
  172. 4 7
  173.  
  174.   The 4 means conference 4, and the 7 are those 3 flags added up (1+2+4=7).
  175.   Real easy. :)
  176.  
  177.   In addition, you can have a seperate CONFREG.xxx file, where xxx is a
  178.   security level, with a different set of conference registrations.
  179.   Just be warned, if you try to auto-reg a LOT of conferences, it could
  180.   take a while.  This is not my fault, blame slow-ass PPL. :)
  181.  
  182. PROVOTE.CNF: Documented within, no need to duplicate everything here.
  183.  
  184. STRINGS.DAT: Documented within, no need to duplicate everything here.  Note
  185.   that each ansi set requires it's own STRINGS.DAT file for proper colors.
  186.  
  187. CARPET.RED: Put the names of people you would like to 'bypass' voting in here,
  188.   they will be given the security level defined in provote.cnf for normal users
  189.   who are voted in.
  190.  
  191. *.PCB:  These are all the files displayed.  If you would like to modify them
  192.   or create your own, just be aware that you MUST get rid of all blank lines
  193.   at the end of the files, or the screens will 'jump up' when displayed.
  194.   LOOK AT THE EXAMPLES INCLUDED TO SEE WHAT THEY CONTAIN AND DETERMINE WHEN
  195.   THEY GET DISPLAYED.  It's pretty straightforward.
  196.   COMMENTS.PCB, INFOFORM.PCB, USERS.PCB, and VOTE.PCB:  These are normal ANSI
  197.     files, and should be saved to clear the screen.
  198.   DELETE.PCB and VALIDATE.PCB:  Normal ANSI files, should be saved to home the
  199.     cursor, NOT to clear the screen.
  200.   CARPETED.PCB, LOCKOUT.PCB, NEWUSER.PCB, WELCOME.PCB and INSTRUCT.PCB:  These
  201.     are simple text files, and can be just about anything you want.
  202.   EXIT.PCB:  This file needs a single "*" somewhere in it to mark the spot to
  203.     display the YES/NO lightbar.  Save it to clear the screen.
  204.   FEEDBACK.PCB:  Similar to exit.pcb, except it needs THREE "*"'s.  First one
  205.     marks the spot to display the SYSOPS HANDLE, second to display the USERS
  206.     HANDLE, and thrid to display the SUBJECT.  Save it to clear the screen.
  207.   STATUS.PCB:  This is the file shown to new users after they have applied and
  208.     are checking on their current voting status.  There are 7 MCI commands
  209.     available ONLY in THIS ansi, as follows:
  210.       |1 = Number of YES votes to validate as per PROVOTE.CNF
  211.       |2 = Number of YES votes user has so far
  212.       |3 = Number of YES votes needed, basically |1 minus |2
  213.       |4 = Number of NO votes to validate as per PROVOTE.CNF
  214.       |5 = Number of NO votes user has so far
  215.       |6 = Number of NO votes needed, basically |4 minus |5
  216.       |7 = Number of ABSTAIN votes user has so far
  217.     Save this file to clear the screen.
  218.  
  219. WELCOME.PCB:  This is teh file that gets sent asa message to all users that
  220.   are validated through PROVOTE.  In addition, you can create level-specific
  221.   files in the format WELCOME.xxx where xxx is a security level.  SO, if for
  222.   instance you as a sysop validate a user and give him level 110, and the
  223.   file WELCOME.110 exists, that will be sent as a message instead of
  224.   WELCOME.PCB.
  225.  
  226. INFOFORM.*:  These are your inofoforms.  You can use ANY (almost) standard
  227.   infoform made for ANY (almost) BBS software that uses the '*' method of
  228.   marking where to ask for input when the form is displayed.  I am fairly sure
  229.   this is a first in a PPE, and I think you will find it
  230.   about 34219136532 times easier to use your own infoforms like this than with
  231.   the retarded X-Y-coordinates-in-a-.DAT-file method. :)  I have programmed it
  232.   in such a way so that when a user is filling out forms, it is impossible to
  233.   "wrap" text to the next line, or to overwrite any existing text on the screen.
  234.   Because of this, your infoforms must have blank space where the users should
  235.   type.  Some infoforms have the users typing over a matted background of some
  236.   sort, these will not work.
  237.   HOW TO MAKE AN INFOFORM:  Load up THEDRAW, and draw your infoform.  Let's
  238.     modify one of the included ones as an example.  First, make sure animation
  239.     mode is OFF by hitting ALT-J,N.  Now make sure there are NO *'s anywhere
  240.     in your infoform.  Now make your modifications to the ansi, being careful
  241.     not to put any text in the 80th column OR past the 23rd row.  When you are
  242.     satisfied with the appearance, turn animation mode ON by hitting ALT-J,T.
  243.     Now CAREFULLY go to each spot you want to get input from, and place a *
  244.     there, in the ORDER you want the questions asked and in the COLOR you want
  245.     the answers to appear in.  If you make a mistake, just turn off animation
  246.     mode, erase all the *'s, and start over.  When you are done, save it by
  247.     hitting ALT-S,A,C,77,0,INFOFORM.x where x is the number you want.  Easy.
  248.  
  249.  
  250. Registration
  251. ~~~~~~~~~~~~
  252. This PPE is totally free, all you need to do is call Velvet Underground and
  253. use the "Reg a ViG! PPE" option from the Matrix.  Be prepared with your NAME
  254. or HANDLE and BBS NAME _exactly_ as it appears in pcbsetup, double check by
  255. looking in PCBOARD.DAT. Line #2 is your name, and line #94 is your BBS name.
  256.  
  257. If you are running a cracked version, GOOD LUCK!  I hope you are very
  258. confident that the person who cracked this knows exactly what he is doing,
  259. the 'protection' routines are tied into a lot of other functions, and if
  260. altered could produce unpredictable (at best) results.  All you need to do is
  261. make a 30 second phone call.
  262.  
  263. Donations are certainly accepted if you feel so compelled, and I won't even
  264. mention the many hours of programming/debugging/testing/whatever spent on
  265. this thing. :)  Cash, old hardware, or even a good leech account on your
  266. board is always appreciated.
  267.  
  268. Velvet Underground (1) 516-826-0412 USR Dual 16.8k
  269. Velvet Underground (2) 516-Pri-Vate USR Dual 28.8k
  270.  
  271.  
  272. Enjoy
  273. ~~~~~
  274. Thats about it, if you have any questions or comments you can reach me
  275. on my board, many other quality boards and nets, Internet address
  276. vigilante@156.image.linet.org, or Prodigy @bwvr36c.
  277.  
  278.  
  279. Other ViG! Utilities:
  280. ~~~~~~~~~~~~~~~~~~~~~
  281. WACKOPROMPT: Floating "SLAM ENTER" prompt replacement.  Very unique, and
  282.              completely configurable.
  283.              Current version: 1.0     Filename: VIG-WP10.ZIP
  284.  
  285. APPCENTER  : Light Bar Application Center.  Have your users apply for dist
  286.              sites, couriers, networks, anything.  Completely configurable.
  287.              Current version: 1.0     Filename: VIG-AC10.ZIP
  288.  
  289. PROMATRIX  : Light Bar Logon Matrix.  Many features, incredibly configurable.
  290.              Companion to ProVote.
  291.              Current version: 1.0     Filename: VIG-PM10.ZIP
  292.  
  293. PROVOTE    : Light Bar New User Voting.  Better than any NUV that is BUILT
  294.              IN to a BBS software, much less a PPE.
  295.              Current version: 1.2     Filename: VIG-PV12.ZIP
  296.  
  297. PROMPTS    : Replaces 52 of your PCBTEXT prompts, totally revamping the entire
  298.              application procedure, logon procedure, F6 Online user editor
  299.              function, and the (C) subcommand form the (7) User Edit sysop
  300.              command.  100% configurable.
  301.              Current version: 1.0     Filename: VIG-PR10.ZIP
  302.  
  303. PROEDIT:     Light Bar User Editor.  For sysops to edit all users, or as the
  304.              (W) command for a user to edit himself.  Emulates PCBSM.
  305.              Current version: 1.0     Filename: VIG-PU10.ZIP
  306.  
  307. SUPERLOGON : "Forum hack" features: broadcast logon to nodes, turbo login,
  308.              random stats, last callers, automessage, one liners, more.
  309.              Current version: 2.0     Filename: VIG-SL20.ZIP
  310.  
  311. CONVERT!   : Successor to PIPE2PCB.  Converts pipe color codes on incoming
  312.              fido mail into standard ANSI color codes on the fly.
  313.              Current version: 1.1     Filename: VIG-C!10.ZIP
  314.  
  315. RUMOURS    : Forum-hack style rumours, completely configurable.  Source
  316.              code included.
  317.              Current version: 2.0     Filename: VIG-RU20.ZIP
  318.  
  319. PCRENFORCER: Enforce Post Call Ratios the RIGHT way.  Totally bars non-PCR
  320.              compliant user from downloading until they post enough messages.
  321.              Current version: 2.0     Filename: VIG-PE20.ZIP
  322.  
  323. SUPERCHAT  : Really nice split screen chat, with a few unique and very handy
  324.              features.
  325.              Current version: 1.1     Filename: VIG-SC11.ZIP
  326.  
  327. MORETIME   : Give more time to users who know the correct password, totally
  328.              independant of security levels.  Source code included.
  329.              Current version: 2.0     Filename: VIG-MT20.ZIP
  330.